<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2014 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo is distributed in the hope that it will be useful, but WITHOUT
     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2014. All rights reserved".
     ********************************************************************************/

    /**
     * Defines the import rules for importing into the users module.
     */
    class UsersImportRules extends ImportRules
    {
        /**
         * Override to handle the password setting as well as not showing all the derived types that are available
         * in other models. This is why this override does not call the parent first.
         * @return array
         */
        public static function getDerivedAttributeTypes()
        {
            return array('Password', 'UserStatus');
        }

        /**
         * Override to block out additional attributes that are not importable
         * @return array
         */
        public static function getNonImportableAttributeNames()
        {
            return array_merge(parent::getNonImportableAttributeNames(), array('isActive', 'hash', 'createdByUser',
                               'modifiedByUser', 'createdDateTime', 'modifiedDateTime', 'isRootUser', 'isSystemUser',
                               'primaryAddress__latitude', 'primaryAddress__longitude', 'primaryAddress__invalid',
                               'hideFromSelecting', 'hideFromLeaderboard', 'serializedAvatarData'));
        }

        public static function getModelClassName()
        {
            return 'User';
        }

        /**
         * Override to add Password as a default field for mapping
         * @param Array $attributesCollection
         */
        protected static function resolveRequiredDerivedAttributesCollection(& $attributesCollection)
        {
            $modelClassName = static::getModelClassName();
            $model          = new $modelClassName(false);
            $attributeImportRulesClassName = 'PasswordAttributeImportRules';
            $attributeImportRules          = new $attributeImportRulesClassName($model);
            $displayLabel                  = $attributeImportRules->getDisplayLabel();
            ModelAttributeImportMappingCollectionUtil::populateCollection(
                $attributesCollection,
                'hash',
                $displayLabel,
                'hash',
                'Password',
                null,
                true
            );
        }
    }
?>